home *** CD-ROM | disk | FTP | other *** search
/ BUG 1 / BUGCD1996_0708.ISO / pc / util / minilin / minilin.exe / USR / LOCAL / LIB / UTREE_HE.{_3 < prev    next >
Text File  |  1992-09-14  |  22KB  |  432 lines
  1. #
  2. #       UTREE.HELP
  3. #       UTREE help pages
  4. #       3.03-um klin, Sun Feb 23 18:45:19 1992
  5. #       Directory:      /usr/local/lib (default)
  6. #
  7. #       Copyright (c) 1991/92 by Peter Klingebiel & UNIX Magazin Muenchen.
  8. #       For copying and distribution information see the file COPYRIGHT.
  9. #
  10. #       Help about items is enclosed in two lines '#@item' and '#@'.
  11. #       The string 'item' is used as item for the menuline, the lines
  12. #       between these opening and closing lines are the help lines
  13. #       for the topic 'item'. The upper case character in 'item' is used
  14. #       as hotkey for selecting help about this topic.
  15. #       Be sure that all items separated by a blank fit in one screen line!
  16. #       Don't change the hot keys because they are hard coded in utree!
  17. #
  18. #       SCCSID=@(#) utree 3.03-um (klin) Feb 23 1992 lib/utree.help
  19.  
  20. #@Help          h: About help
  21.  
  22.        The utree help page menu lets you select help pages about the
  23.        following topics (menu hotkeys are enclosed in brackets):
  24.  
  25.        (h) Help        This help page.
  26.        (a) About       About utree and some naming conventions.
  27.        (u) Usage       Utree usage and command line options.
  28.        (g) Global      Global commands for tree and file screen.
  29.        (t) Tree        Commands for the tree screen.
  30.        (f) File        Commands for the file screen.
  31.        (e) Edit        Commands for the builtin line editor.
  32.        (v) Vars        Utree variables and variable definition.
  33.        (c) Cmds        Filetype dependent command definition.
  34.        (l) Line        Line format for tree, file and filetype commands.
  35.        (k) Keys        Function keys used by utree.
  36.        (p) Patterns    File and time pattern matching.
  37. #@
  38. #@About         a: About utree and key naming conventions
  39.  
  40.        This is utree 3.03-um, a screen oriented filesystem browser.
  41.  
  42.          Copyright (c) 1991/92 Peter Klingebiel & UNIX Magazin.
  43.                        All rights reserved.
  44.  
  45.        First utree version (utree 1.00) created in July 1988.
  46.  
  47.        The naming conventions for keys in the help pages are:
  48.        'C-key' means hold the <CONTROL>-key and hit <key>,
  49.        'key' means a single keystroke on the key <key>.
  50.  
  51.        For many commands on tree and file screen case is significant.
  52.        Commands given in lowercase letters work on the current directory
  53.        or file, commands given in uppercase letters work on the current
  54.        subtree or on tagged files in current subtree or directory.
  55.  
  56.        Many function keys are supported by utree, i.e the four cursor
  57.        keys, the begin and end key and some others. For more information
  58.        about default key bindings and user definable keybindings see
  59.        the keys help page.
  60. #@
  61. #@Usage         u: About utree usage and command line options
  62.  
  63.        Usage:  utree [-LSVabcghnrqstuw] [-d var=[val]] [-d typ:[cmd]]
  64.                      [-f lst] [-i ind] [-l lev] [-p lin] [-v mod] [-x cmd]
  65.                      [rootdir]
  66.  
  67.        The meaning of the command line options is:
  68.  
  69.        -L              Follow symbolic links.
  70.        -S              Ignore default minimal screen size.
  71.        -V              Display program version.
  72.        -a              Read in all (including hidden) directories.
  73.        -b              Suppress ringing of the bell.
  74.        -c              Don't display and update a clock in echoline.
  75.        -d var=[val]    Define/undefine variable var.
  76.        -d typ:[cmd]    Set/unset type command for filetype typ.
  77.        -f lst          Build tree from list file lst.
  78.        -g              Don't use graphic characters.
  79.        -h              Display usage and meaning of command line options.
  80.        -i ind          Set maximal tree indention to ind
  81.        -l lev          Build tree up to level lev.
  82.        -n              Don't scan tree for changes in tree.
  83.        -o              Omit saving changes in history/definitions/bindings.
  84.        -p lin          Set file window to lin lines (1..9)
  85.        -q              Build tree up to level 2 (like -l 2).
  86.        -r              Recreate tree list (always scan disk).
  87.        -s              Don't use hardware scrolling.
  88.        -t              Sort files by modification times.
  89.        -u              Update file lists in tree.
  90.        -v mod          Set video attribute setting (0,1,2)
  91.        -w              Suppress warnings about unreadable directories.
  92.        -x cmd          Use string cmd as initial command input.
  93.  
  94.        The boolean options bcgnosw and the numerical options ipv may also
  95.        be pre-set in the environment variable UTREE.
  96. #@
  97. #@Global        g: About global commands for tree and file screen
  98.  
  99.        The following commands are common for tree and file screen:
  100.  
  101.        C-z             Terminate and leave utree.
  102.        C-c,C-y         Cancel command or input.
  103.        C-l             Refresh/redisplay screen.
  104.        Tab,C-t         Move to next tagged directory or file.
  105.        h,?.C-r         Change to help screen for displaying help pages.
  106.        @,C-@           Mark current directory or file.
  107.        #,C-g           Move to previously marked directory/file or position.
  108.        a               Display utree version.
  109.        d               Display current date and time.
  110.        j               Next directory or file (for vi fans).
  111.        k               Previous directory or file (for vi fans).
  112.        w               Display full pathname of current directory.
  113.        =               Change to variables screen for setting variables.
  114.        :               Change to commands screen for setting filetype commands.
  115.        |               Change to bindings screen for binding keys.
  116.        !               Change to shell screen for execution of shell commands.
  117.        $               Escape to an interactive shell session.
  118. #@
  119. #@Tree          t: About utree directory tree screen commands
  120.  
  121.        All tree commands can be given in lowercase or uppercase letters For
  122.        some commands a lowercase letter hits the current directory only, an
  123.        uppercase letter hits a complete subtree or all tagged files in subtree.
  124.  
  125.        >,CR,NL,SP      Change to file screen of current directory.
  126.        <               Change to file screen of parent directory.
  127.        C-n             Move to next directory.
  128.        C-p             Move to previous directory.
  129.        C-f             Move to next directory on same level.
  130.        C-b             Move to previous directory on same level.
  131.        C-v             Move one page forward.
  132.        C-w             Move one page backward.
  133.        C-a             Move to begin of directory tree.
  134.        C-e             Move to end of directory tree.
  135.        TAB,C-t         Move to next directory containing tagged files.
  136.        C-u             Scroll up directory tree.
  137.        C-d,            Scroll down directory tree.
  138.        @,C-@           Mark current directory.
  139.        #,C-g           Goto previously marked directory.
  140.        b,B             Backup all files/tagged files in subtree.
  141.        c,C             Change to a directory/Copy tagged files.
  142.        f,F             Find files in current directory/subtree.
  143.        g,G             Search for pattern in files in directory/subtree.
  144.        i               Show some directory information.
  145.        l,L             List files/tagged files in current subtree.
  146.        m,M             Make a new directory/Move tagged files.
  147.        n,N             Change sort criteria, sort files in directory/subtree.
  148.        o               Write a list of directories, files or tagged files.
  149.        q               Exit utree.
  150.        r,R             Remove current directory/Remove tagged files.
  151.        s               Show/change status of current directory.
  152.        t,T             Tag files in current directory/subtree.
  153.        u,U             Untag files in current directory/subtree.
  154.        z,Z             Zoom files in current directory/subtree.
  155.        +               Enlarge tree window if possible.
  156.        -               Shrink tree window if possible.
  157.        /               Scan tree and rebuild directories if needed.
  158.        \               Scan directory for subdirectories and insert subtree.
  159.        0               Switch tree/user commands menuline.
  160.        1..9            Execute user defined tree command.
  161.  
  162.        For further information about filename patterns for the commands find,
  163.        grep, list, tag, untag and zoom see the pattern help page.
  164. #@
  165. #@File          f: About utree file screen commands
  166.  
  167.        All file commands can be given in lower or upper case letters.
  168.        For most commands a lowercase letter hits the current file only,
  169.        an uppercase letter hits all selected (tagged) files.
  170.  
  171.        q,CR,NL,SP      Change back to tree screen.
  172.        C-f             Move to next file.
  173.        C-b             Move to previous file.
  174.        C-n             Move to file on next line.
  175.        C-p             Move to file on previous line.
  176.        C-v             Move one page forward.
  177.        C-w             Move one page backward.
  178.        C-a             Move to first file.
  179.        C-e             Move to last file.
  180.        TAB,C-t         Move to next tagged file.
  181.        C-u             Scroll up file screen.
  182.        C-d             Scroll down file screen.
  183.        @,C-@           Mark current file.
  184.        #,C-g           Goto previously marked file.
  185.        c,C             Copy file/tagged files.
  186.        e,E             Edit file/tagged files.
  187.        f               Find files matching a pattern.
  188.        g,G             Search for pattern in file/tagged files.
  189.        i,I             Show some information about file/tagged files.
  190.        l,L             List files matching a pattern/tagged files.
  191.        m,M             Rename/move file/tagged files.
  192.        n               Change sort criteria and resort file list.
  193.        p,P             Send file/tagged files to printer spooler.
  194.        r,R             Remove file/tagged files.
  195.        s,S             Show/change status of file/tagged files.
  196.        t,T             Tag/select files for further processing.
  197.        u,U             Untag file/tagged files.
  198.        v,V             View file/tagged files.
  199.        x               Execute current file or call a command for it.
  200.        z               Zoom files in file list.
  201.        >               If current file is a directory, change to.
  202.        <               Change back to parent directory.
  203.        /               Rebuild file list (i.e. after shell escape).
  204.        0               Switch file/user commands menuline.
  205.        1..9            Execute user defined file command.
  206.  
  207.        For further information about filename patterns for the commands find,
  208.        grep, list, tag, untag and zoom see the pattern help page.
  209. #@
  210. #@Edit          e: About utree line editor commands
  211.  
  212.        The builtin utree line editor knows the following functions:
  213.        (Function keys are supported if known by termcap/terminfo)
  214.  
  215.        CR,NL           Accept and send input line.
  216.        C-c,C-y         Cancel input line and line editor.
  217.        C-o             Switch insert/overwrite mode.
  218.        C-l             Redisplay input line.
  219.        C-f             Move cursor one character forward.
  220.        C-b             Move cursor one character backward.
  221.        C-a             Move cursor to beginning of line.
  222.        C-b             Move cursor to end of line.
  223.        C-v             Scroll forward line.
  224.        C-w,            Scroll backward line.
  225.        C-d             Delete character under cursor.
  226.        C-h,DEL         Delete character left from cursor.
  227.        C-x             Delete line.
  228.        C-k             Delete from cursor position to end of line.
  229.        C-t             Transpose characters under and left from cursor.
  230.        C-r             Display help menu and pages.
  231.        C-@             Set mark at current position.
  232.        C-g             Move cursor to previously set mark.
  233.        C-p             Get previous list entry into line editor.
  234.        C-n             Get next list entry into line editor.
  235. #@
  236. #@Vars          v: About utree variables
  237.  
  238.        Utree knows about and uses the following variables which may be
  239.        set/unset at startup in the startupfile '$HOME/.utree', with the
  240.        commandline option '-d' or the variables command '=':
  241.  
  242.        BL      BELL            Allow ringing of the bell.
  243.        CL      CLOCK           Show and update clock every second.
  244.        GC      GRAPHCHARS      Use graphical character set.
  245.        TS      TERMSCROLL      Use hardware terminal scrolling.
  246.        ST      SCANTREE        Allow scanning the filesystem for changes.
  247.        WD      WARNDIRS        Make warnings about unreadable directories.
  248.        LS      LEXSORT         Sort filenames in file lists in lexical order.
  249.        AS      AUTOSAVE        Save changes in history, variables and command
  250.                                definitions and key bindings.
  251.        TI      TREEINDENT      Maximal tree indention on tree screen (3..9).
  252.        VM      VIDEOMODE       Using of video attributes (0=none,1,2=all).
  253.        FL      FILELINES       Maximal file lines on tree screen (1..9).
  254.        HS      HISTSIZE        Size of history list (Settable at startup only).
  255.        SH      SHELL           Interactive shell.
  256.        ED      EDITOR          Editor.
  257.        EO      EDITOPTS        Editor options.
  258.        PG      PAGER           File pager/viewer.
  259.        PO      PAGEOPTS        Pager options.
  260.        XD      XDUMPER         File hexdumper.
  261.        XO      XDUMPOPTS       Dumper options.
  262.        LP      LPRINTER        Printer spooler command.
  263.        LO      LPRINTOPTS      Printer options.
  264.        BK      BACKUP          Backup program.
  265.        BO      BACKUPOPTS      Backup options.
  266.        T1..9   TREECMD1..9     User defined commands 1..9 for tree screen.
  267.        F1..9   FILECMD1..9     User defined commands 1..9 for file screen.
  268.  
  269.        Variables are set with a line 'shorthand=value' or 'variable=value'
  270.        (i.e. 't1=ps -ef'), unset with a line 'shorthand=' or 'variable='
  271.        (i.e. 't1='). When defining user tree or file commands some sprintf
  272.        like format characters lead in by a percent sign ('%') have a
  273.        special meaning and are expanded before the command is executed (See
  274.        also the help page line). A sharp sign (#) in a variable definition
  275.        is used as leadin for a menu item of the defined user file or tree
  276.        command or as comment.
  277.  
  278.        E.g.: the variable definition 'fc1=wc -l %F # Count' for user
  279.        defined file command 1 is expanded to 'wc -l filename' and in the
  280.        user command file menu 'Count' is displayed behind menu item 1.
  281. #@
  282. #@Cmds          c: About filetype dependent commands
  283.  
  284.        On file screen you can execute a file or a command on it with
  285.        the utree command execute ('x'). You are requested for parameters
  286.        if the current file is executable, for a command to execute on the
  287.        current file if the current file is not executable. For a type of file
  288.        you can define so called filetype commands which are called if the
  289.        current file matches this filetype (or extension).
  290.  
  291.        Filetype commands can be set/unset at startup in the startupfile
  292.        '$HOME/.utree', with the commandline option '-d' or the filetype
  293.        command ':' similar to setting/unsetting variables.
  294.        Filetype commands are set with a line like 'filetype:command'
  295.        (e.g. '*.c:cc -c -O'). The command ('cc -c -O') is then executed if
  296.        the current file matches the filetype pattern (e.g. '*.c' for 'foo.c').
  297.        Filetype commands are unset with a line 'filetype:' (i.e. '*.c:').
  298.  
  299.        When defining filetype commands some sprintf like format characters
  300.        lead in by a percent sign ('%') have a special meaning and are
  301.        expanded before the command is executed. For further information
  302.        about filename patterns and the format characters and her meaning
  303.        see the pattern and line help pages.
  304. #@
  305. #@Line          l: About line format for tree, file and filetype commands
  306.  
  307.        When defining a user defined tree or file command or a filetype
  308.        command or when entering a shell command some sprintf like format
  309.        characters are known and expanded before the command is executed.
  310.        These format characters and their meaning are:
  311.  
  312.        %B,%b   Basename of current file or directory.
  313.        %D,%d   Full pathname of current directory.
  314.        %F,%f   Filename of current file or directory.
  315.        %H,%h   Full pathname of home directory.
  316.        %R,%r   Full pathname of root directory.
  317.        %P,%p   Full pathname of current file or directory.
  318.        %S,%s   Additional parameter(s) for a command which are requested
  319.                before the command is executed.
  320.  
  321.        E.g. the command line 'command %s %f >%b.out' is expanded before
  322.        execution to 'command parameters filename basename.out' with filename
  323.        and basename.out ('%f', '%b.out') of the current file or directory and
  324.        parameters ('%s') which are requested before the command is executed.
  325.  
  326.        For further information about tree/file and filetype commands see
  327.        the vars and defs help pages.
  328. #@
  329. #@Keys          k: About default and user definable key bindings
  330.  
  331.        The following list denotes the names of all utree keys, their default
  332.        key bindings and their meanings on tree and file screen or in the line
  333.        editor (See also the help pages global, tree, file and edit).
  334.  
  335.        SELECT   (CR,NL) Select directory/file or accept input line.
  336.        FORWARD  (C-f)   Move forward directory/file or character.
  337.        BACKWARD (C-b)   Move back directory/file or character.
  338.        NEXT     (C-n)   Move to next directory or file or get next list entry
  339.                         into the line editor.
  340.        PREVIOUS (C-p)   Move to previous directory or file or get previous list
  341.                         entry into the line editor.
  342.        NEXTPAGE (C-v)   Next page/Scroll forward input line.
  343.        PREVPAGE (C-w)   Previous page/Scroll backward input line.
  344.        BEGIN    (C-a)   Move to beginning of directories/files or input line.
  345.        END      (C-e)   Move to end of directories/files or input line.
  346.        UP       (C-u)   Scroll down up one line directories or files.
  347.        DOWN     (C-d)   Scroll down one line directories or files (on screens)
  348.                         or delete character under the cursor (in line editor).
  349.        INSERT   (C-o)   Toggle insert/overwrite mode flag (in line editor)
  350.                         or change to current directory (on screens).
  351.        DELETE   (BS)    Delete character left from cursor (in editor) or
  352.                         change to parent directory (on screens).
  353.        KILL     (C-k)   Delete from cursor position to end of input line.
  354.        SETMARK  (C-@)   Set a mark on current directory/file or at cursor
  355.                         position.
  356.        GOTOMARK (C-g)   Move to previously marked directory/file or character.
  357.        GOTOTAG  (TAB)   Move to tagged directory or file (on screens) or
  358.                         transpose characters (in line editor).
  359.        HELP     (C-r)   Get help pages and change to help screen.
  360.        REFRESH  (C-l)   Refresh and redraw screen or input line.
  361.        CANCEL   (C-x)   Delete whole input line and leave line editor.
  362.        BREAK    (C-c)   Break current command or line editor.
  363.        EXIT     (C-z)   Terminate and leave utree.
  364.  
  365.        The following function keys are bound at startup if they are defined
  366.        in your system's termcap or terminfo database:
  367.  
  368.        CursorRight     FORWARD
  369.        CursorLeft      BACKWARD
  370.        CursorUp        PREVIOUS
  371.        CursorDown      NEXT
  372.        Home/Begin      BEGIN
  373.        End             END
  374.        NextPage        NEXTPAGE
  375.        PreviousPage    PREVPAGE
  376.        ScrollUp        UP
  377.        ScrollDown      DOWN
  378.        Insert          INSERT
  379.        Delete          DELETE
  380.        Clear           REFRESH
  381.        Help            HELP
  382.        Select          SELECT
  383.        Do/Command      SELECT
  384.        Mark            SETMARK
  385.        Enter           SELECT
  386.  
  387.        You may bind any key to the denoted utree key symbols or to string on
  388.        the binding screen or in terminal startup files with the name
  389.        '.utree-term' in your home directory ('term' is the terminal type from
  390.        $TERM). This files contain lines built like 'key_sequence=key_name'
  391.        or 'keysequence="string"' for string insertion bindings.
  392.        E.g. the line '\eh=HELP' binds the key <ESC><h> to HELP and and the
  393.        line '\ei="insert"' binds <ESC><i> to insertion of the string 'insert'
  394.        into the input buffer for further reading and interpretation.
  395. #@
  396. #@Patterns      p: About pattern matching
  397.  
  398.        Some commands (list, find, grep, tag or untag) require filename
  399.        patterns for matching files using some special (meta) characters.
  400.  
  401.        File NAME pattern matching interprets the following meta chars:
  402.        *       matches all characters in a filename.
  403.        ?       matches one character in a filename.
  404.        [class] matches all characters enclosed in brackets '[' and ']'
  405.                where '!' and '-' have a special meaning, i.e.
  406.                [abc]   matches the characters 'a', 'b' and 'c'.
  407.                [a-z_]  matches the characters from 'a' to  'z' and '_'.
  408.                [!a-z_] matches all characters except 'a' to 'z' and '_'.
  409.  
  410.        File SIZE pattern matching interprets the following meta chars:
  411.        =size   matches all files equate size
  412.        !size   matches all files not equate size
  413.        >size   matches all files larger than size
  414.        <size   matches all files smaller than size
  415.        You may specify the file size in bytes (b, default), kilo bytes (k)
  416.        or mega bytes (m), i.e. '>2k' matches all files larger than 2 kb or
  417.        2048 bytes.
  418.  
  419.        File TIME pattern matching interprets the following meta chars:
  420.        )time   matches all files modified within time.
  421.        (time   matches all files not modified within time.
  422.        You may specify time in minutes (m), hours (h, default), days (d) or
  423.        weeks (w), i.e. ')2d' matches all files modified within last 2 days.
  424.  
  425.        To combine file name, size and time patterns use
  426.        &       for ANDing of name/size/time patterns
  427.        |       for ORing  of name/size/time patterns.
  428.        If a character is preceeded by a backslash (\) or enclosed in quotes
  429.        his interpretation is suppressed and he is used as he is.
  430. #@
  431.  
  432.